home *** CD-ROM | disk | FTP | other *** search
/ Aminet 31 / Aminet 31 (1999)(Schatztruhe)[!][Jun 1999].iso / Aminet / comm / news / slrn-bin.lha / slrn / doc / tm / slrnfuns / group.tm < prev    next >
Text File  |  1999-04-27  |  2KB  |  89 lines
  1. \function{current_newsgroup}
  2. \synopsis{-}
  3. \usage{String current_newsgroup ()}
  4. \description
  5.    This function returns the name of the current newsgroup.
  6. \seealso{server_name}
  7. \done
  8.  
  9. \function{get_group_flags}
  10. \synopsis{-}
  11. \usage{Integer get_group_flags ()}
  12. \description
  13.    This function returns the flags associated with the current
  14.    newsgroup.  This integer is a bitmapped value whose bits are
  15.    defined by the following constants:
  16. #v+
  17.      GROUP_UNSUBSCRIBED   : set if the group is unsubscribed
  18.      GROUP_NEW_GROUP_FLAG : set if the group is new
  19. #v-
  20. \seealso{get_header_flags, set_group_flags, current_newsgroup}
  21. \done
  22.  
  23. \function{group_down_n}
  24. \synopsis{-}
  25. \usage{Integer group_down_n (Integer n)}
  26. \description
  27.    This function moves the current group pointer down \var{n} groups and
  28.    returns the actual number moved.
  29. \seealso{group_up_n, group_search, current_newsgroup}
  30. \done
  31.  
  32. \function{group_search}
  33. \synopsis{-}
  34. \usage{Integer group_search (String name)}
  35. \description
  36.    This function searches for a newsgroup containing the string
  37.    \var{name}.  It also searches newsgroup descriptions.  A non-zero value
  38.    is returned upon success or zero upon failure.
  39. \notes
  40.    This search may wrap.
  41. \seealso{select_group, current_newsgroup}
  42. \done
  43.  
  44. \function{group_unread}
  45. \synopsis{-}
  46. \usage{Integer group_unread ()}
  47. \description
  48.    This function returns the number of unread articles in the current
  49.    newsgroup.
  50. \seealso{select_group, current_newsgroup, is_group_mode}
  51. \done
  52.  
  53. \function{group_up_n}
  54. \synopsis{-}
  55. \usage{Integer group_up_n (Integer n)}
  56. \description
  57.    This function moves the current group pointer up \var{n} groups and
  58.    returns the actual number moved.
  59. \seealso{group_down_n, group_search, current_newsgroup}
  60. \done
  61.  
  62. \function{is_group_mode}
  63. \synopsis{-}
  64. \usage{Integer is_group_mode ()}
  65. \description
  66.    This function returns non-zero if the current mode is group-mode.
  67. \seealso{}
  68. \done
  69.  
  70. \function{select_group}
  71. \synopsis{-}
  72. \usage{Integer select_group ()}
  73. \description
  74.    This function may be used to select the current group.  It returns
  75.    0 upon success or -1 upon failure.  It can fail if the group has no
  76.    articles.
  77. \seealso{current_newsgroup}
  78. \done
  79.  
  80. \function{set_group_flags}
  81. \synopsis{-}
  82. \usage{Void set_group_flags (Integer flags)}
  83. \description
  84.    This function may be used to set the flags associated with the
  85.    current newsgroup.
  86. \seealso{get_group_flags}
  87. \done
  88.  
  89.